home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / tex / readyref.zip / READYREF.DOC < prev    next >
Text File  |  1988-05-17  |  61KB  |  1,366 lines
  1.  
  2.  
  3.  
  4.                                     ReadyRef
  5.                                     ========
  6.  
  7.                               An On-Line Reference
  8.                               --------------------
  9.  
  10.                                  Ver.  2.30(10)
  11.  
  12.                                        by
  13.                                   W.G. Madison
  14.  
  15.  
  16.                 Copyright 1988 W.G. Madison and Associates, Ltd.
  17.                               All rights reserved.
  18.  
  19.  
  20.  
  21.  
  22.  
  23.                  ┌─────────┐
  24.             ┌────┴────┐    │                      W. G. MADISON AND
  25.           ──┤         │    ├─────────────────         ASSOCIATES, Ltd.
  26.             │  ┌──────┴──┐ │  Association of      P. O. Box 898
  27.             │  │         ├─┘  Shareware           Greenbelt, MD 20770
  28.             └──┤    o    │    Professionals       (301)552-7234
  29.           ─────┤    ║    ├───────────────────     (CIS 73240,342)
  30.           (tm) └────╨────┘    MEMBER
  31.  
  32.  
  33.  
  34.  
  35.  
  36.             ========================================================
  37.             |                       Shareware                      |
  38.             |                                                      |
  39.             | We encourage you to freely copy and share UNMODIFIED |
  40.             | copies  of this program  with other  people.  If you |
  41.             | decide to use the  program,  support  the  Shareware |
  42.             | marketing  concept by  becoming  a registered  user. |
  43.             ========================================================
  44.  
  45.  
  46.  
  47.                                 TABLE OF CONTENTS
  48.                                 =================
  49.  
  50.         1.        INTRODUCTION ..................................... 1
  51.         1.0       What is ReadyRef, and why should I bother? ....... 1
  52.         1.1       Acknowledgments .................................. 2
  53.  
  54.         2.        THE DISTRIBUTION SET ............................. 3
  55.  
  56.         3.        TEST DRIVING AND INVOKING READYREF ............... 3
  57.         3.1       Invoking ReadyRef and using its options .......... 4
  58.  
  59.         4.        INSTALLING READYREF .............................. 5
  60.         4.0       System Requirements .............................. 5
  61.         4.1       General considerations ........................... 5
  62.         4.1.1     Summary of the installation/configuration process. 6
  63.         4.2       Using RRCONFIG to initially configure ReadyRef ... 8
  64.         4.2.1     Selecting a color set ............................ 8
  65.         4.2.2     Selecting an initial option set .................. 9
  66.  
  67.         5.        DEFINING USER-CONFIGURABLE OPTIONS FROM SCRATCH .. 10
  68.         5.0       General discussion ............................... 10
  69.         5.1       Preparing a text file for a user definable option. 11
  70.         5.2       Using RRCONFIG to install a new option ........... 12
  71.         5.3       Searching a text file ............................ 13
  72.         5.4       Preparing and using configuration files .......... 15
  73.  
  74.         6.        INDEXING TEXT FILES .............................. 15
  75.         6.0       General discussion ............................... 15
  76.         6.1       Using RRINDEX .................................... 16
  77.  
  78.         7.        AVAILABLE READYREF-COMPATIBLE TEXT FILES ......... 16
  79.  
  80.         8.        USAGE/COPYING LICENSE ............................ 17
  81.         8.0       What is Shareware? ............................... 17
  82.         8.1       Your rights and obligations ...................... 18
  83.         8.2       Software/Shareware dealers and distributors ...... 19
  84.         8.3       How to register ReadyRef ......................... 19
  85.         8.4       User Support ..................................... 19
  86.  
  87.         9.        Other Shareware Products ......................... 20
  88.  
  89.  
  90.  
  91.         1.   INTRODUCTION
  92.  
  93.         1.0  What is ReadyRef, and why should I bother?
  94.  
  95.         All too frequently, if you are like me, you will be sitting at 
  96.         your computer and want a quick piece of information. You have to 
  97.         break your train of thought, find the book or document containing 
  98.         the information you require, look it up, and then go back to the 
  99.         computer and pick up where you left off. Even if the information 
  100.         is on your hard disk and you have SideKick or SCOUT installed, it 
  101.         can be a nuisance getting to, and reading the specific file you 
  102.         want.
  103.  
  104.         And most of the time (again, if you are like me) the information 
  105.         you need amounts to only a few lines of text which could readily 
  106.         be associated with a keyword.
  107.  
  108.                             ReadyRef MEETS THIS NEED!
  109.  
  110.         ReadyRef is an on-line reference aid. Unlike most on-line refer-
  111.         ence aids, however, you decide for yourself the subject matter 
  112.         for which you are most likely to need on-line assistance. You 
  113.         decide for yourself the wording and form this assistance will 
  114.         take. If you don't like what you have decided after using it for 
  115.         a while, you can change it in any way you wish. In short, you are 
  116.         not bound by someone else's decision as to what you want or need.
  117.  
  118.         Thus, ReadyRef can, over time, become the reference aid specific-
  119.         ally designed for you and your work style. 
  120.  
  121.         ReadyRef can be used as a resident program (TSR) or can be run in 
  122.         non-resident mode, runnable from the DOS prompt. It provides a 
  123.         suite of up to 14 options, consisting of
  124.  
  125.                        * A complete ASCII table
  126.  
  127.                        * A calendar displaying any desired three month 
  128.                          period
  129.  
  130.                        * A date calculator, to determine
  131.                             * the number of days between any two given 
  132.                               dates
  133.                             * the date corresponding to any number of 
  134.                               days before or after a given date
  135.                             * the day of the week on which any date, past 
  136.                               or future, falls
  137.  
  138.                        * Eleven additional options which you can define 
  139.                          for yourself, if you can use any editor or word 
  140.                          processor capable of producing an ASCII file.
  141.                             * One of these options, providing reference 
  142.                               on the syntax and function of the more 
  143.                               common DOS commands, is pre-installed.
  144.  
  145.  
  146.  
  147.  
  148.                                    1
  149.  
  150.  
  151.  
  152.         1.1  Acknowledgments
  153.  
  154.         Nothing worthwhile is conceived or created in a vacuum. ReadyRef 
  155.         is no exception. While the actual detailed design and coding may 
  156.         be a solo effort, the ideas leading up to the design, the Beta 
  157.         Testing support following initial implementation, and the contin-
  158.         ued feedback during the development process come from many 
  159.         sources. Some of the contributors may not even be aware that, 
  160.         during a free-wheeling conversation, a chance remark may have 
  161.         lead to a valuable new view of a problem. 
  162.  
  163.         In particular,
  164.  
  165.         To John Van Horn, Wallace Kendall, and Paul Demmitt for input 
  166.         which, in many ways, determined some of the major features of 
  167.         ReadyRef;
  168.  
  169.         To John Newlin, who directed my attention to bodies of potential 
  170.         users whose needs would have otherwise escaped my attention;
  171.  
  172.         To both Johns, Wallace, and Paul (once again) as well as to the 
  173.         many members of the Central Maryland Microcomputer Users' Group 
  174.         who provided the frequently painful and embarrassing but neces-
  175.         sary Beta Testing services;
  176.  
  177.         And finally, to my wife Frances, who has had to put up with late 
  178.         nights and frequent bouts of the "dark grumps" while all of this 
  179.         was taking place -- 
  180.  
  181.         Much of the credit for any success which ReadyRef may enjoy is 
  182.         rightfully yours. Thank you.
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203.  
  204.  
  205.  
  206.  
  207.  
  208.  
  209.